Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposition ajout du modèle datasheet for datasets #57

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

samgoeta
Copy link

Bonjour,

merci pour ce guide. Je vous propose de rajouter le modèle Datasheet for Datasets qui propose une liste intéressante de questions. Elles peuvent servir de guide dans la description des données.

N'hésitez pas à simplifier, modifier, adapter les questions… C'est fait pour.

A bientôt

Samuel

Copy link
Member

@AntoineAugusti AntoineAugusti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merci @samgoeta pour cette contribution très pertinente.

J'ai remis en forme le Markdown. J'attends de voir ce que @mathildehg en pense, il y a potentiellement des questions déjà abordées dans d'autres paragraphes. On peut également utiliser des fonctionnalités des plateformes pour renseigner certaines informations (couverture temporelle, géographique, fréquence de mise à jour) et non le mettre dans la description textuelle du JDD

@mathildehg
Copy link
Contributor

Merci @samgoeta pour cette contribution ! La liste des questions est très pertinente.

Cependant, certaines parties sont redondantes avec les paragraphes qui suivent :

  • Description du mode de production des données => Pourquoi le jeu de données a-t-il été initialement créé ? / Processus de collecte des données
  • Description du modèle de données => Dispose-t-on d'un schéma décrivant les variables du jeu de données ? / Que contient chaque champ du jeu de données ?
  • Description des métadonnées : Selon quelle licence les données sont-elles diffusées ? / Le jeu de données sera-t-il mis à jour ? Si oui, à quelle fréquence ?

=> j'ai peur que la page devienne trop fouillis si nous intégrons les modifications telles quelles. Par contre, ce serait vraiment dommage de ne pas intégrer les éléments pointés dans chaque question.

Ce qui me vient en tête :

  • Nous intégrons les éléments à l'intérieur des paragraphes, quitte à créer de nouveaux paragraphes si nécessaire ;
  • À la fin de la page, nous pointons le modèle Datasheet for Datasets avec un call to action du style "Vérifiez que vous avez validé toutes les étapes de votre documentation grâce aux questions suivantes"

Qu'en pensez-vous ?

@samgoeta
Copy link
Author

Merci @mathildehg ! J'avais aussi l'impression qu'il pouvait y avoir des redondances mais la solution que tu proposes me parait très bien.

@AntoineAugusti
Copy link
Member

Hello 👋,

Cette PR est ouverte depuis longtemps. Qui est en charge de faire des modifications ? @samgoeta, @mathildehg, avez-vous pu convenir de ce qui nécessitait d'être fait ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants